Skip to content

doc: Add demo about how to use OVERLAY in linker scripts #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fanghuaqi merged 1 commit into from
Sep 28, 2025
Merged

doc: Add demo about how to use OVERLAY in linker scripts #57

fanghuaqi merged 1 commit into from
Sep 28, 2025

Conversation

@qiujiandong
Copy link
Contributor

@qiujiandong qiujiandong commented Sep 26, 2025 •
edited by ellipsis-dev bot
Loading

Important

Add documentation on using OVERLAY in linker scripts with a demo, updating index files accordingly.

  • Documentation:
    • Adds 29-using_overlay_command_in_linker_scripts.md to explain using OVERLAY in linker scripts with a demo program.
    • Updates README.md and mkdocs.yml to include the new document in the documentation index.

This description was created by Ellipsis for 3e37e02. You can customize this summary. It will automatically update as commits are pushed.

ellipsis-dev[bot]
ellipsis-dev bot reviewed Sep 26, 2025
View reviewed changes
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to 3e37e02 in 1 minute and 26 seconds. Click for details.
  • Reviewed 203 lines of code in 3 files
  • Skipped 1 files when reviewing.
  • Skipped posting 9 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. 29-using_overlay_command_in_linker_scripts.md:17
  • Draft comment:
    Typo: 'Stuido' should be 'Studio'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a change since it's a new file, the comment is about a simple typo in a product name. It's a very minor issue that doesn't affect code functionality or documentation clarity. The rules state we should not make purely informative comments or point out obvious/unimportant issues. The product name being incorrect could potentially confuse readers trying to find the correct software. Names and links are important for documentation accuracy. While product names are important, this is such an obvious typo that readers would easily understand the intended meaning. The link is correct which is what matters most for finding the software. This comment should be deleted as it points out a trivial typo that doesn't meaningfully impact understanding or functionality.
2. 29-using_overlay_command_in_linker_scripts.md:79
  • Draft comment:
    Typo: '_ovly_tabel' should be '_ovly_table'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically correct - there is a typo in the comment - it's an extremely minor issue. The actual code is correct, and the typo doesn't affect functionality or understanding. Comments are documentation and while accuracy is good, this level of nitpicking on typos doesn't add meaningful value. The typo could theoretically confuse someone searching for documentation about _ovly_table. Also, maintaining high quality even in comments shows attention to detail. The variable name is used correctly everywhere else including the code, so the chance of confusion is minimal. The comment's meaning is still clear despite the typo. This comment should be deleted as it points out an extremely minor typo in a comment that doesn't impact code functionality or clarity.
3. 29-using_overlay_command_in_linker_scripts.md:157
  • Draft comment:
    Typo: 'Cachebale' should be corrected to 'Cacheable'.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a typo, it's a very minor spelling error in documentation. The meaning is still clear from context. The rules say not to make purely informative comments or comments about obvious issues. Spelling fixes generally fall into this category unless they significantly impact understanding. The word "Cacheable" is a technical term, so having it spelled correctly could be important for readers searching for information or understanding the concept. While correct spelling is good, this particular typo doesn't significantly impact understanding - the meaning is clear from context and the surrounding technical discussion about caches. This comment should be deleted as it's a minor spelling correction that doesn't materially impact understanding of the technical content.
4. README.md:33
  • Draft comment:
    README timestamp updated; new overlay doc entry added appears correct.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
5. mkdocs.yml:36
  • Draft comment:
    New nav entry for '29-using_overlay_command_in_linker_scripts.md' added; ordering looks consistent.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
6. 29-using_overlay_command_in_linker_scripts.md:17
  • Draft comment:
    Typo: "Nuclei Stuido IDE" should be "Nuclei Studio IDE".
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is a real typo, it's a very minor issue in documentation. The meaning is still clear despite the typo. The rules state we should not make purely informative comments or comments about obvious/unimportant issues. This seems to fall into that category. The typo is in a product name, which could be considered more important than a regular spelling error. It could confuse users trying to search for the correct product. While product names are important, this is still a very minor issue that doesn't affect functionality or understanding. The link still works correctly and users would easily understand what's meant. This comment should be deleted as it points out a minor documentation issue that doesn't significantly impact understanding or functionality.
7. 29-using_overlay_command_in_linker_scripts.md:79
  • Draft comment:
    Typo in comment: "_ovly_tabel" should be "_ovly_table".
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a typo, it's just in a comment, not in actual code. The variable name itself on line 80 is spelled correctly as "_ovly_table". The typo in the comment doesn't affect functionality. Comments are documentation and while accuracy is good, this is a very minor issue. The typo could be confusing to readers since it's documenting a variable name. Consistency between comments and code is valuable for maintainability. While consistency is good, this is an extremely minor documentation issue that doesn't impact understanding - the correct spelling is used immediately in the actual code on the next line. This comment should be deleted as it points out a trivial typo in a comment that doesn't meaningfully impact code understanding or functionality.
8. 29-using_overlay_command_in_linker_scripts.md:157
  • Draft comment:
    Typo: "Cachebale" should be "Cacheable".
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a typo, it's a very minor one that doesn't affect understanding of the technical content. The word appears in a note about cache consistency, and the meaning is clear from context. The rules state we should not make purely informative comments or obvious/unimportant ones. The typo could potentially confuse non-native English speakers or make the documentation look less professional. The meaning is still clear from context, and this is a very minor issue that doesn't affect the technical accuracy or usability of the documentation. This comment should be deleted as it's too minor and doesn't affect the technical content or require any meaningful code changes.
9. README.md:37
  • Draft comment:
    There appears to be a typographical error in the filename: "3-print_memor_usage_in_ide.md". Should "memor" be corrected to "memory"?
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_HQAnzQKs6yzCntcq

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@qiujiandong
doc: Add demo about how to use OVERLAY in linker scripts
d0446c1 
Signed-off-by: qiujiandong <qiujiandong@nucleisys.com>
@fanghuaqi fanghuaqi merged commit 1e79940 into Nuclei-Software:main Sep 28, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ellipsis-dev ellipsis-dev[bot] ellipsis-dev[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@qiujiandong @fanghuaqi